﻿#region Copyright (c) 2010 R. Uittenbosch
/*
* Copyright (C) 2010 R. Uittenbosch
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 
* associated documentation files (the "Software"), to deal in the Software without restriction, including 
* without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
* copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the 
* following conditions:
* 
* The above copyright notice and this permission notice shall be included in all copies or substantial 
* portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
* LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO 
* EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE 
* USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#endregion

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace LinkedService.Mobile
{
  /// <summary>
  /// Interface to retrieve/set configuration items
  /// </summary>
  public interface IConfiguration
  {
    /// <summary>
    /// Get a list of all items in the configuration
    /// </summary>
    string[] ContainedItems { get; }

    /// <summary>
    /// Add a key/value combination to the configuration
    /// </summary>
    /// <typeparam name="T">The type of object to add.</typeparam>
    /// <param name="name">The name of the object to add</param>
    /// <param name="item">The actual value</param>
    void SetItem<T>(string name, T item);

    /// <summary>
    /// Get an item from the configuration
    /// </summary>
    /// <typeparam name="T">The type of object to retrieve</typeparam>
    /// <param name="name">The name of the object to retrieve</param>
    /// <returns>The actual object value</returns>
    T GetItem<T>(string name);

    /// <summary>
    /// Get an item from the configuration
    /// </summary>
    /// <typeparam name="T">The type of object to retrieve</typeparam>
    /// <param name="name">The name of the object to retrieve</param>
    /// <param name="def">The default value in case the value did not yet exists in the configuration</param>
    /// <returns>The actual object value</returns>
    T GetItem<T>(string name, T def);
  }
}
